home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3x / curs_pad.z / curs_pad
Encoding:
Text File  |  2002-10-03  |  11.0 KB  |  130 lines
  1.  
  2.  
  3.  
  4. ccccuuuurrrrssss____ppppaaaadddd((((3333XXXX))))                                                      ccccuuuurrrrssss____ppppaaaadddd((((3333XXXX))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _cccc_uuuu_rrrr_ssss______pppp_aaaa_dddd: _nnnn_eeee_wwww_pppp_aaaa_dddd, _ssss_uuuu_bbbb_pppp_aaaa_dddd, _pppp_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh, _pppp_nnnn_oooo_uuuu_tttt_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh, _pppp_eeee_cccc_hhhh_oooo_cccc_hhhh_aaaa_rrrr, _pppp_eeee_cccc_hhhh_oooo_wwww_cccc_hhhh_aaaa_rrrr -
  10.      create and display _cccc_uuuu_rrrr_ssss_eeee_ssss pads
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>>
  14.  
  15.      _WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_nnnn_eeee_wwww_pppp_aaaa_dddd_((((_iiii_nnnn_tttt _nnnn_llll_iiii_nnnn_eeee_ssss_,,,, _iiii_nnnn_tttt _nnnn_cccc_oooo_llll_ssss_))))_;;;;
  16.      _WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_ssss_uuuu_bbbb_pppp_aaaa_dddd_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_oooo_rrrr_iiii_gggg_,,,, _iiii_nnnn_tttt _nnnn_llll_iiii_nnnn_eeee_ssss_,,,, _iiii_nnnn_tttt _nnnn_cccc_oooo_llll_ssss_,,,,
  17.           _iiii_nnnn_tttt _bbbb_eeee_gggg_iiii_nnnn______yyyy_,,,, _iiii_nnnn_tttt _bbbb_eeee_gggg_iiii_nnnn______xxxx_))))_;;;;
  18.      _iiii_nnnn_tttt _pppp_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_pppp_aaaa_dddd_,,,, _iiii_nnnn_tttt _pppp_mmmm_iiii_nnnn_rrrr_oooo_wwww_,,,, _iiii_nnnn_tttt _pppp_mmmm_iiii_nnnn_cccc_oooo_llll_,,,,
  19.           _iiii_nnnn_tttt _ssss_mmmm_iiii_nnnn_rrrr_oooo_wwww_,,,, _iiii_nnnn_tttt _ssss_mmmm_iiii_nnnn_cccc_oooo_llll_,,,, _iiii_nnnn_tttt _ssss_mmmm_aaaa_xxxx_rrrr_oooo_wwww_,,,, _iiii_nnnn_tttt _ssss_mmmm_aaaa_xxxx_cccc_oooo_llll_))))_;;;;
  20.      _iiii_nnnn_tttt _pppp_nnnn_oooo_uuuu_tttt_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_pppp_aaaa_dddd_,,,, _iiii_nnnn_tttt _pppp_mmmm_iiii_nnnn_rrrr_oooo_wwww_,,,, _iiii_nnnn_tttt _pppp_mmmm_iiii_nnnn_cccc_oooo_llll_,,,,
  21.           _iiii_nnnn_tttt _ssss_mmmm_iiii_nnnn_rrrr_oooo_wwww_,,,, _iiii_nnnn_tttt _ssss_mmmm_iiii_nnnn_cccc_oooo_llll_,,,, _iiii_nnnn_tttt _ssss_mmmm_aaaa_xxxx_rrrr_oooo_wwww_,,,, _iiii_nnnn_tttt _ssss_mmmm_aaaa_xxxx_cccc_oooo_llll_))))_;;;;
  22.      _iiii_nnnn_tttt _pppp_eeee_cccc_hhhh_oooo_cccc_hhhh_aaaa_rrrr_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_pppp_aaaa_dddd_,,,, _cccc_hhhh_tttt_yyyy_pppp_eeee _cccc_hhhh_))))_;;;;
  23.      _iiii_nnnn_tttt _pppp_eeee_cccc_hhhh_oooo_wwww_cccc_hhhh_aaaa_rrrr_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_pppp_aaaa_dddd_,,,, _cccc_hhhh_tttt_yyyy_pppp_eeee _wwww_cccc_hhhh_))))_;;;;
  24.  
  25. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.      The _nnnn_eeee_wwww_pppp_aaaa_dddd routine creates and returns a pointer to a new pad data
  27.      structure with the given number of lines, _n_l_i_n_e_s, and columns, _n_c_o_l_s.  A
  28.      pad is like a window, except that it is not necessarily associated with a
  29.      viewable part of the screen.  Automatic refreshes of pads (e.g., from
  30.      scrolling or echoing of input) do not occur.  It is not legal to call
  31.      _wwww_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh with a _p_a_d as an argument; the routines _pppp_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh or _pppp_nnnn_oooo_uuuu_tttt_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh
  32.      should be called instead.  Note that these routines require additional
  33.      parameters to specify the part of the pad to be displayed and the
  34.      location on the screen to be used for the display.
  35.  
  36.      The _ssss_uuuu_bbbb_pppp_aaaa_dddd routine creates and returns a pointer to a subwindow within a
  37.      pad with the given number of lines, _n_l_i_n_e_s, and columns, _n_c_o_l_s.  Unlike
  38.      _ssss_uuuu_bbbb_wwww_iiii_nnnn, which uses screen coordinates, the window is at position
  39.      (_b_e_g_i_n__x_,,,, _b_e_g_i_n__y) on the pad.  The window is made in the middle of the
  40.      window _o_r_i_g, so that changes made to one window affect both windows.
  41.      During the use of this routine, it will often be necessary to call
  42.      _tttt_oooo_uuuu_cccc_hhhh_wwww_iiii_nnnn or _tttt_oooo_uuuu_cccc_hhhh_llll_iiii_nnnn_eeee on _o_r_i_g before calling _pppp_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh.
  43.  
  44.      The _pppp_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh and _pppp_nnnn_oooo_uuuu_tttt_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh routines are analogous to _wwww_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh and
  45.      _wwww_nnnn_oooo_uuuu_tttt_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh except that they relate to pads instead of windows.  The
  46.      additional parameters are needed to indicate what part of the pad and
  47.      screen are involved.  _p_m_i_n_r_o_w and _p_m_i_n_c_o_l specify the upper left-hand
  48.      corner of the rectangle to be displayed in the pad.  _s_m_i_n_r_o_w, _s_m_i_n_c_o_l,
  49.      _s_m_a_x_r_o_w, and _s_m_a_x_c_o_l specify the edges of the rectangle to be displayed
  50.      on the screen.  The lower right-hand corner of the rectangle to be
  51.      displayed in the pad is calculated from the screen coordinates, since the
  52.      rectangles must be the same size.  Both rectangles must be entirely
  53.      contained within their respective structures.  Negative values of
  54.      _p_m_i_n_r_o_w, _p_m_i_n_c_o_l, _s_m_i_n_r_o_w, or _s_m_i_n_c_o_l are treated as if they were zero.
  55.  
  56.  
  58.  
  59.  
  60.                                                                         PPPPaaaaggggeeee 1111
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67. ccccuuuurrrrssss____ppppaaaadddd((((3333XXXX))))                                                      ccccuuuurrrrssss____ppppaaaadddd((((3333XXXX))))
  68.  
  69.  
  70.  
  71.      The _pppp_eeee_cccc_hhhh_oooo_cccc_hhhh_aaaa_rrrr routine is functionally equivalent to a call to _aaaa_dddd_dddd_cccc_hhhh
  72.      followed by a call to _rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh, a call to _wwww_aaaa_dddd_dddd_cccc_hhhh followed by a call to
  73.      _wwww_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh, or a call to _wwww_aaaa_dddd_dddd_cccc_hhhh followed by a call to _pppp_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh_....  The
  74.      knowledge that only a single character is being output is taken into
  75.      consideration and, for non-control characters, a considerable performance
  76.      gain might be seen by using these routines instead of their equivalents.
  77.      In the case of _pppp_eeee_cccc_hhhh_oooo_cccc_hhhh_aaaa_rrrr, the last location of the pad on the screen is
  78.      reused for the arguments to _pppp_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh.
  79.  
  80.      The _pppp_eeee_cccc_hhhh_oooo_wwww_cccc_hhhh_aaaa_rrrr routine is functionally equivalent to a call to _aaaa_dddd_dddd_wwww_cccc_hhhh
  81.      followed by a call to _rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh, a call to _wwww_aaaa_dddd_dddd_wwww_cccc_hhhh followed by a call to
  82.      _wwww_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh, or a call to _wwww_aaaa_dddd_dddd_wwww_cccc_hhhh followed by a call to _pppp_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh_....
  83.  
  84. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  85.      Routines that return an integer return _EEEE_RRRR_RRRR upon failure and an integer
  86.      value other than _EEEE_RRRR_RRRR upon successful completion.
  87.  
  88.      Routines that return pointers return _NNNN_UUUU_LLLL_LLLL on error.
  89.  
  90. NNNNOOOOTTTTEEEESSSS
  91.      The header file _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>> automatically includes the header files
  92.      _<<<<_ssss_tttt_dddd_iiii_oooo_...._hhhh_>>>> and _<<<<_uuuu_nnnn_cccc_tttt_rrrr_llll_...._hhhh_>>>>.
  93.  
  94.      Note that _pppp_eeee_cccc_hhhh_oooo_cccc_hhhh_aaaa_rrrr may be a macro.
  95.  
  96. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  97.      _cccc_uuuu_rrrr_ssss_eeee_ssss(3X), _cccc_uuuu_rrrr_ssss______rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh(3X), _cccc_uuuu_rrrr_ssss______tttt_oooo_uuuu_cccc_hhhh(3X), _cccc_uuuu_rrrr_ssss______aaaa_dddd_dddd_cccc_hhhh(3X),
  98.      _cccc_uuuu_rrrr_ssss______aaaa_dddd_dddd_wwww_cccc_hhhh(3X).
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.                                                                         PPPPaaaaggggeeee 2222
  127.  
  128.  
  129.  
  130.